Wallet to wallet transfer
Use this endpoint to make a payment between wallets of the same currency.
All payments in Customate have a source (funding source) and a destination (payee). Funding sources and payees have a type.
When a profile is created and verified, a funding source and a payee (both of type wallet) are created.
Specify the payee ID of the recipient. The payee must be of type wallet and the currency must match the specified currency. The funding source will be determined from the data.
Specify the amount (in pence/cents), an optional description and metadata.
Required information for the endpoint, wallet_to_wallet_payments
- amount, in pence or cents
- currency (GBP or EUR – more currencies to follow)
- payee ID (must be of type wallet)
Optional information
- description
- execution date (UTC, in YYYY-MM-DD format, takes place after any bank holidays or weekends)
- metadata (useful for storing client-specific information, e.g. your payment ID)
Example JSON request
{
"amount": 1200,
"description": "Deposit for apartment #121",
"currency": "GBP",
"execution_date": "2022-04-12",
"metadata": {
"sample_internal_id": "d2f148cf-901c-4fee-8792-21016da755a0"
},
"payee_id": "fdbf7995-84f6-4c28-b5e8-9ebec78c8edc"
}
Example response
{
"id": "00c7cc70-6fcb-4d0f-89de-3387e2a284c3",
"creation_datetime": "202109-30T12:28:22.768085Z",
"amount": 1200,
"scenario": "OutgoingInternal",
"status": "processing",
"currency": "GBP",
"description": "Deposit for apartment #121",
"wallet_id": "37cc0dd7-0744-48b2-946d-506e4b26074b",
"execution_date": "2022-04-12",
"metadata": {},
"funding_source": {
"id": "b5e1923c-5477-4d2b-8bb9-2ae7746f172f"
},
"payee": {
"id": "a3aa2dfa-a994-4fe0-bbe3-0eeb09830290"
}
}
Example Scenario 1: Money out from a wallet to another wallet
1 – User sent £1.07 from wallet A to wallet B at 06:55:42 UTC Wednesday 1 Sep.
2 – Customate wallet type.payment status moves from PENDING to PROCESSING to SUCCESS
Webhook: 1
{
"items": [
{
"id": "0a2fc967-8dda-4435-a7f7-fab087f6762d",
"type": "payment.updated",
"creation_datetime": "2021-09-01T06:55:42.567276+00:00",
"data": {
"status": "pending",
"metadata": {},
"scenario": "OutgoingInternal",
"error_code": null,
"error_message": null,
"closing_balance": 55942,
"funding_source": {
"id": "4e9bcad1-485a-4fef-8470-f32abe9ea834"
},
"payee": {
"id": "00daeb49-2c3e-4884-a177-1965893980d3"
},
"id": "bfefca19-7c0f-460f-a86a-f91361fecd3e",
"schedule": {
"id": "7e00958c-577e-48b3-846d-f7b52eb78083"
},
"profile": {
"id": "d871c453-18fe-497e-a84a-01b0f14d7a7c"
}
}
},
{
"id": "0c070972-a321-4666-b65f-9318ee65aed9",
"type": "payment.updated",
"creation_datetime": "2021-09-01T06:55:42.721581+00:00",
"data": {
"status": "pending",
"metadata": {},
"scenario": "OutgoingInternal",
"error_code": null,
"error_message": null,
"closing_balance": 0,
"funding_source": {
"id": "4e9bcad1-485a-4fef-8470-f32abe9ea834"
},
"payee": {
"id": "00daeb49-2c3e-4884-a177-1965893980d3"
},
"id": "bfefca19-7c0f-460f-a86a-f91361fecd3e",
"schedule": {
"id": "7e00958c-577e-48b3-846d-f7b52eb78083"
},
"profile": {
"id": "d871c453-18fe-497e-a84a-01b0f14d7a7c"
}
}
}
]
}
Webhook 2
{
"items": [
{
"id": "ef972fe9-d629-4d22-97a6-a59f06d2ac4b",
"type": "transaction.updated",
"creation_datetime": "2021-09-01T06:55:43.824293+00:00",
"data": {
"name": "IncomingInternal",
"amount": 107,
"status": "success",
"metadata": {},
"error_code": null,
"net_amount": "107",
"error_message": null,
"closing_balance": 1194,
"external_reference": null,
"funding_source": {
"id": "4e9bcad1-485a-4fef-8470-f32abe9ea834"
},
"payee": {
"id": "00daeb49-2c3e-4884-a177-1965893980d3"
},
"schedule": {
"id": "7e00958c-577e-48b3-846d-f7b52eb78083"
},
"id": "8792db1f-ae90-4a18-b264-9ae2ce31779b",
"payment": {
"id": "44a57e56-e145-43c4-987f-de49676d24fd"
},
"profile": "cb56f9eb-c7b4-43be-bde4-09a4bb60e380",
"fee": 0
}
},
{
"id": "01335d8c-b67b-4fdc-b677-0ee9813bf763",
"type": "payment.updated",
"creation_datetime": "2021-09-01T06:55:43.834976+00:00",
"data": {
"status": "success",
"metadata": {},
"scenario": "IncomingInternal",
"error_code": null,
"error_message": null,
"closing_balance": 1194,
"funding_source": {
"id": "4e9bcad1-485a-4fef-8470-f32abe9ea834"
},
"payee": {
"id": "00daeb49-2c3e-4884-a177-1965893980d3"
},
"id": "44a57e56-e145-43c4-987f-de49676d24fd",
"schedule": {
"id": "7e00958c-577e-48b3-846d-f7b52eb78083"
},
"profile": {
"id": "cb56f9eb-c7b4-43be-bde4-09a4bb60e380"
}
}
},
{
"id": "d3fc1806-5f99-4b5c-a723-e0317cf84d45",
"type": "payment.updated",
"creation_datetime": "2021-09-01T06:55:43.934645+00:00",
"data": {
"status": "processing",
"metadata": {},
"scenario": "OutgoingInternal",
"error_code": null,
"error_message": null,
"closing_balance": 55942,
"funding_source": {
"id": "4e9bcad1-485a-4fef-8470-f32abe9ea834"
},
"payee": {
"id": "00daeb49-2c3e-4884-a177-1965893980d3"
},
"id": "bfefca19-7c0f-460f-a86a-f91361fecd3e",
"schedule": {
"id": "7e00958c-577e-48b3-846d-f7b52eb78083"
},
"profile": {
"id": "d871c453-18fe-497e-a84a-01b0f14d7a7c"
}
}
}
]
}
Webhook 3
{
"items": [
{
"id": "450015ee-2166-4989-abc7-41813e1764f2",
"type": "transaction.updated",
"creation_datetime": "2021-09-01T06:55:43.905397+00:00",
"data": {
"name": "OutgoingInternal",
"amount": -107,
"status": "success",
"metadata": {},
"error_code": null,
"net_amount": "-107",
"error_message": null,
"closing_balance": 55942,
"external_reference": null,
"funding_source": {
"id": "4e9bcad1-485a-4fef-8470-f32abe9ea834"
},
"payee": {
"id": "00daeb49-2c3e-4884-a177-1965893980d3"
},
"schedule": {
"id": "7e00958c-577e-48b3-846d-f7b52eb78083"
},
"id": "07460c5a-ddc0-4696-a7f1-af517bb0c4c9",
"payment": {
"id": "bfefca19-7c0f-460f-a86a-f91361fecd3e"
},
"profile": "d871c453-18fe-497e-a84a-01b0f14d7a7c",
"fee": 0
}
},
{
"id": "cb0a3f2b-9b67-42e7-afc6-df56a401646b",
"type": "payment.updated",
"creation_datetime": "2021-09-01T06:55:44.212216+00:00",
"data": {
"status": "success",
"metadata": {},
"scenario": "OutgoingInternal",
"error_code": null,
"error_message": null,
"closing_balance": 55942,
"funding_source": {
"id": "4e9bcad1-485a-4fef-8470-f32abe9ea834"
},
"payee": {
"id": "00daeb49-2c3e-4884-a177-1965893980d3"
},
"id": "bfefca19-7c0f-460f-a86a-f91361fecd3e",
"schedule": {
"id": "7e00958c-577e-48b3-846d-f7b52eb78083"
},
"profile": {
"id": "d871c453-18fe-497e-a84a-01b0f14d7a7c"
}
}
}
]
}