Transfers

Resources

Access to remittances:

 Access to payments of the connected user
/api/(partner_domain)/payments/

 Access to payments of the user belonging to the connected third-party application
/api/(partner_domain)/users/appuserid/payments/

1.Payment
Send money item is an item which allows to send money between two accounts (or sub-account).

Property Type Example Description
OrderId String “order_001” Money transfer identifier in the third-party application
Id Long 18 Money transfer identifier
PaymentDate DateTime "2013-09-10T
15:50:37.2363199
+02:00"		 Payment date
Amount Long 1250 Payment amount (in cents)
Fee Fee Item containing a fee
Status Int 1 Payment status
0 = Waiting
1 = Refund
2 = Expired
3 = Completed
4 = Error
Beneficiary SubAccountRef Item containing recipient details
Message String "Breakfast" Money transfer message
Sender SubAccountRef Item containing sender details
If not indicated, it is a connected user default account which is used

2.SubAccountRef
This item allows to identify the accounts between which the transactions are made.

Property Type Example Description
Id Long 98 Account identifier
AppAccountId String "123" Account identifier provided by the third-party application
DisplayName String "Jean Dupont" Account display name
Href Uri "/api/accounts/123" Uri for account details

3.Fee
The Fee item defines the applicable fees.

Property Type Example Description
Amount long 150 Fee amount in cents (VAT not included)
VAT double 20 Fee percentage
AmountWithVAT long 180 Fee amount in cents (VAT included)
Status Int 1 Fee status
0 = Waiting
1 = Completed
2 = Refunded
3 = Failed
5 = Cancelled

Send money

To send money, please have a look at the example in the right margin of this page.

Error cases:

HTTP Code Error code Explication
401 362 Operation not allowed
401 569 Token OAuth expired
401 570 Token OAuth invalid
400 704 Missing request parameter
400 177 Invalid request parameter
404 147 Account cannot found
400 500 The sender account is blocked
400 111 Sender status is invalid
400 127 The sender and the recipient cannot have be the same account
400 345 Recipient account is incorrect or incomplete
400 110 Insufficient balance to make the operation
400 701 Transaction limit has been reached (client unbanked)
400 702 Transaction limit has been reached (KYC client)
400 703 Transaction limit has been reached (no KYC client)
400 177 Parameter value is invalid (orderId already exists)
400 177 Invalid parameter value (All the orderId parameters should be unique)

Retrieve the list of money transfers

In order to retrieve the list of remittances, please have a look at the example in the right margin of this page.

Error cases :

HTTP code Error code Explication
401 362 Operation not allowed
401 569 Token OAuth expired
401 570 Token OAuth invalid

Retrieve a money transfer

In order to retrieve the list of remittances, please have a look at the example in the right corner of this page.

Error cases:

HTTP code Error code Explication
401 362 Operation not allowed
401 569 Token OAuth expired
401 570 Token OAuth invalid
404 356 Operation cannot be found