Appearance
Cashing
Cashing checks implies a digital and a physical process.
- Payin creation – You create a
Payin
object, with information about the Check - Check mail in – You send the physical check to Treezor via mail (within 14 days)
The funds are credited to the wallet when the physical check is received and approved.
When a check is physically processed, payin.update
webhooks are sent informing you of the changes.
Information – Checks must:
- Be sent via mail, as no physical agencies are available
- Be received within 14 calendar days of the Payin creation (otherwise, the Payin status is set to
151134
) - Bear the following information: Name, Account Number, Date, Signature
Creation
Mandatory parameters
Attribute | Type | Description |
---|---|---|
paymentMethodId | integer | Must be 26 for checks. |
amount | float | The amount of the check. |
walletId | string | The unique identifier of the Wallet to credit (recipient). |
currency | string | The currency of the check. |
additionalData | object | Contains the cmc7 line, the drawer data and the RLMC key of the check. |
Request example
Use the following request to create a Payin object for your check:
bash
curl -X POST {baseUrl}/payins \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
-d '{payload}'
1
2
3
4
2
3
4
Here is an example of {payload}
:
json
{
"walletId": "123456",
"paymentMethodId":26,
"amount":991.25,
"currency":"EUR",
"additionalData":
{
"cheque":{
"cmc7" : {
"a":"000036", // required, 1st section of CMC7 line
"b":"0230021566985", // required, 2nd section of CMC7 line
"c":"00700065456" // required, 3rd section of CMC7 line
},
"RLMCKey":"22", // required, RMLC key
"drawerData":{ // required object
"isNaturalPerson" : true, // required, boolean, true: physical / false: legal entity
"email":"aoak@example.com", // drawer's email
"firstName" : "Alex", // drawer's firstname
"lastName" : "Oak", // drawer's lastname
"address" : "22 Rosewood Lane", // drawer's address
"address2" : "App. 12", // drawer's address continued
"zipCode" : "75001", // drawer's postcode
"city" : "Paris" // drawer's city
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Returns the Payin object if successful.
json
{
"payins": [
{
"payinId": "cf7544f4-15ef-44df-9e6b-ac50ef5xxxx",
"payinTag": null,
"walletId": "123456",
"userId": "852741",
"payinStatus": "PENDING",
"paymentMethodId": "26",
"messageToUser": "",
"subtotalItems": "100.00",
"subtotalServices": "0.00",
"subtotalTax": "0.00",
"amount": "100.00",
"currency": "EUR",
"createdDate": "2018-01-01 17:00:00",
"walletEventName": "Wallet Test",
"walletAlias": "test-wallet-abcd",
"userFirstname": "CMA",
"userLastname": "",
"codeStatus": "151124",
"informationStatus": "",
"refundAmount": null,
"ibanFullname": "",
"DbtrIBAN": "",
"ibanBic": "",
"ibanTxEndToEndId": "XXXXXXXXX",
"ibanTxId": "180799999990292",
"forwardUrl": null,
"paymentAcceptedUrl": null,
"paymentRefusedUrl": null,
"paymentWaitingUrl": null,
"paymentExceptionUrl": null,
"paymentCanceledUrl": null,
"payinDate": null,
"mandateId": null,
"creditorName": "ALEX OAK",
"creditorAddressLine": null,
"creditorCountry": null,
"creditorIban": "FR761679999999999XX9011835",
"creditorBIC": "TRZOFR21XXX",
"virtualIbanId": null,
"virtualIbanReference": null,
"ibanId": "995d69d1839999999999a6935979ea8110d8"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Mail in
Once the Payin is created, the Check can mailed to the address indicated below. Checks must be received within 14 days after the Payin Creation.
CENTRE DE TRAITEMENT
TSA 80007
33625 BORDEAUX CEDEX 9
Life cycle
Checks cash-in may have different outcomes, whether they are accepted or not. If the check bounces within the 11-day delay, the Payin is canceled. Otherwise, a Payin refund is created.
Here is an illustration of the check life cyle:
Examples
Find below Check life cycle examples.
Accepted check
Step | Status | Code | Description | |
---|---|---|---|---|
#1 | PENDING | 151124 | Waiting for check mail-in | |
#2 | PENDING | 151132 | Check has been received | |
#3 | PENDING | 151129 | Check has been submitted to the bank | |
#4 | PENDING | 151130 | Check is awaiting validation | |
#5 | VALIDATED | 140005 | Payment validated |
Error during handling
Step | Status | Code | Description | |
---|---|---|---|---|
#1 | PENDING | 151124 | Waiting for check mail-in | |
#2 | PENDING | 151132 | Check has been received | |
#3 | CANCELED | 151125 | Payin has been canceled due to an issue with the check |