LogoLogo
NymCardAPI catalogContact usnFront catalog
  • NYMCARD DOCUMENTATION
  • Get Started
    • nCore API Quick Tutorial
    • API Core Principles
    • Program management
      • Manage documents by APIs
      • User KYB process
      • Necessary parameters per user type
      • User ID verification by SDK
      • User KYC process
    • Issuance
      • Users
      • Cards
    • Issuing Physical Cards
      • Individual card issuance
      • Bulk card issuance
      • Card fulfillment
      • Card PIN management
      • Card replacement
      • Proxy number usage
    • Issuing Virtual Cards
      • Migration of virtual to physical card
    • Funding and transfers
      • Funding
      • Internal funding source
      • External funding source
        • From card
        • From bank account
        • Lean API flow
        • DAPI direct API flow
      • Transfers
      • Western Union APIs
    • Product Management
      • Card product
      • Balance limits
      • Velocity limits
      • Fees
      • Charges
      • Multi-currency
      • Authorization controls
        • Enhancements for MCC list management
    • Transactions
      • Payment ecosystem
      • Transaction lifecycle
      • Transaction types
      • Transaction endpoints scenarios
      • Multi-clearing process
    • Webhooks
      • Introduction to webhooks
      • nCore webhook events
      • Steps to configure a webhook
      • Webhooks samples
      • Webhook changes for simulation
      • Webhooks management
    • Security
      • PCI widget
      • 3D Secure
      • OTP SMS templates
    • Release announcements
      • Embedded Lending Release Notes
      • Changes in the release on 13/07/2023
      • Changes in the release on 23/05/2023
      • Changes in the release on 04/04/2023
  • For developers
    • nCore API catalog
    • nFront API catalog
Powered by GitBook
On this page
  • Introduction
  • Transfer funds
  • Retrieve transfers
  • Transfer between user's OWN account/wallet

Was this helpful?

  1. Get Started
  2. Funding and transfers

Transfers

PreviousDAPI direct API flowNextWestern Union APIs

Last updated 9 months ago

Was this helpful?

Introduction

nCore platform support fund transfer from one account to another account. Using this fund transfer method you can move funds between your own account as well as to any other user’s account which is also known as a peer to peer (P2P) transfer. The fund transfer method has a real time effect which means that the funds will be debited from the sender account and immediately credited to the recipient account.

Account transfers pre-requisite

Following are the prerequisites for funds sender and funds receiver accounts.

Transfer funds

You can transfer funds from one account to another account by sending a POST request to /transfers endpoint as given below.

Retrieve transfers

The nCore platform offers the following retrieval options for transfers.

Retrieve all transfers

You can retrieve all existing transfers by sending a GET request to /transfers endpoint shown below.

Retrieve a list of transfers by filters

You can retrieve transfers by using the applicable filters given below.

Filter parameter

Description

sender_account_id

Sender account Identifier. You can use sender account id to get all the account transfers performed by a user.

recipient_account_id

Recipient account Identifier. You can use the receiver's account id to get all the account transfers received by a user.

transfer_date_time_start

Date and time of a transfer, starting with which you want to filter a list of transfers.

transfer_date_time_end

Date and time of a transfer, ending with which you want to filter a list of transfers.

You can use the above filter parameters in combination as well to get a precise list of transfers.

Retrieve a specific transfer

You can retrieve a specific transfer by sending a GET request to /transfers/{id} endpoint, where id is the transfer ID.

Transfer between user's OWN account/wallet

We've implemented new enums for the 'transfer_type' parameter, enabling the system to differentiate whether a transfer occurs between the user's OWN account/wallet or not. When transferring between the user's own accounts, the transfer_type will indicate 'OWN' (e.g. CHA2CHAOWN).

Here are the various account types and their meanings:

  • CHA: Cardholder Account

  • CHCA: Cardholder Child Account

  • AMA: Agent Master Account

  • AMCA: Agent Master Child Account

  • CHMCA: Cardholder Master Child Account

  • CHMA: Cardholder Master Account

For further information regarding card products, please refer to section .

{ "sender_account_id": "bc121529-e6e9-45f1-b820-8c46ce7f005a", "recipient_account_id": "39dbff34-5505-4181-9e81-727b71e72186", "amount": 100, "currency": "USD", "notes": "Account transfer for 100 USD", "dry_run": false }

{ "transaction_id": "123456789012", "sender_account_id": "bc121529-e6e9-45f1-b820-8c46ce7f005a", "recipient_account_id": "39dbff34-5505-4181-9e81-727b71e72186", "transfer_date_time_start": “10012021", “transfer_date_time_end”: “11012021” }

Furthermore, we've added a new 'transfer_type' field to the TRANSACTIONS .

Product management
POST /transfers
GET /transfers
GET /transfers
GET /transfers/{id}
webhook
Drawing