Retrieve transfers
Usually accumulated payment point balance is transferred once per day to a specified merchant account. You might have to wait until the next day to get a transfer and for the funds to appear in the bank account.
Get a single transfer​
Returns a single completed transfer.
$ curl -X 'GET' \
'https://api.mobilepay.dk/v3/reporting/transfers/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
-H 'Authorization: Bearer {API_KEY}' \
-H 'Content-Type: application/json' \
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentPointId": "52b2c75a-513b-43a6-9f4f-0c4c80f8e15b",
"reference": "string",
"date": "string",
"totalTransferredAmount": 0,
"currencyCode": "string"
}
Retrieve a list of transfers​
Returns a list of completed transfers for a payment point.
$ curl -X 'GET' \
'https://api.mobilepay.dk/v3/reporting/transfers?pagesize=1000&pagenumber=1' \
-H 'Authorization: Bearer {API_KEY}' \
-H 'Content-Type: application/json' \
{
"pageSize": 1,
"nextPageNumber": 2,
"transfers": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"paymentPointId": "52b2c75a-513b-43a6-9f4f-0c4c80f8e15b",
"reference": "string",
"date": "string",
"totalTransferredAmount": 0,
"currencyCode": "string"
}
]
}
Transfer reference​
The transfer reference is a unique reference which MobilePay generates for all individual transfers, and is visible on the bank statement when the transfer has been completed and received on your bank account. The reference always consists of 20 characters.
Use this reference to identify and verify which transfers were received on the bank account. The format of transfer reference can be defaulted or customized via payment point creation in the portal.
Default transfer reference​
PCAAAAAAAARRRDDMMYYX
Characters | Description |
---|---|
PC | Product code – the product identified by a code, when generating the reference. 01 - POS, 02 - MyShop, 03 - Subscriptions, 04 - Invoice, 06 - Online, 08 - App Payments. |
AAAAAAAA | The external paymentPointID (length 8) is unique per payment point. For the product’s Subscription and Invoice the external paymentPointID will consist of 8 zeros (00000000). For MyShop it will be MyShop number, for PoS it will be PoS LocationID. |
RRR | The running number (incremented with each transfer and reset each day) |
DD | Day |
MM | Month |
YY | Year |
X | Check digit added automatically |
Example: 02000123450010408221
- 02 = transfer from MyShop product
- 00012345 = transfer from the payment point with the MyShop number 12345
- 001 = the first transfer on the bank account that day
- 040822 = date of the transfer
- 1 = control digit
The reference 02000123450010408221 in this example correspond to the transfer done by the MyShop product from the payment point with the MyShop number 12345 done at August 4, 2022.
Another example: 03000000000011602221 - which indicates Subscriptions transfer received February 16, 2022.
Custom transfer reference​
Custom transfer reference consists of 20 characters: 19 - set by you and a check digit which is always automatically added at the end of the reference. One of the use cases for custom transfer reference is when there is a need to set up automation to transfer money further, i.e. franchisee.
Characters | Action |
---|---|
0-9 | Your own numbers and it will not be replaced |
RRR | Will be replaced with the running number (incremented with each transfer and reset each day) Running number is unique for every payment point |
DD | Will be replaced with the current day |
MM | Will be replaced with the current month |
YY | Will be replaced with the current year |
X | Check digit added automatically |
Example: Payment point has custom transfer reference set to "RRR5555555555YYMMDD". Reference in bank statement "00155555555552203273" indicates that the transfer was the first transfer for this payment point and it was made on March 27, 2022.