These are sample payloads that can be used when creating an expected payment. To automatically reconcile Expected Payments to Transactions, you will need to also create reconciliation rules to specify how the data will be used for matching.
Expecting to be charged
The following request will indicate that you are expecting to be charged $10.
{
"reconciliation_rule_variables":[
{
"direction": "debit",
"amount_lower_bound": 100000,
"amount_upper_bound": 100000,
"internal_account_id": "<Internal Account ID>"
}
]
}
Expecting to receive money
The following request will indicate that you're expecting to receive $200,000
{
"reconciliation_rule_variables":[
{
"direction": "credit",
"amount_lower_bound": 20000000,
"amount_upper_bound": 20000000,
"internal_account_id": "<Internal Account ID>"
}
]
}
Using Ranges
The following request uses ranges to show that you're expecting to receive between $100-$110, sometime between the dates 5/15/2024-5/22/2024. A reconciliation rule can be created to ensure a transaction will only reconcile if it matches these criteria.
{
"reconciliation_rule_variables":[
{
"direction": "credit",
"amount_lower_bound": 10000,
"amount_upper_bound": 11000,
"internal_account_id": "<Internal Account ID>",
"date_lower_bound": "2024-05-15",
"date_upper_bound": "2024-05-22"
}
]
}
Using Custom Identifiers
The following request enables you to add custom_identifiers to further restrict the reconciliation rule to only match transactions that have specific remittance information included, such as the email address or payment_id present in the transaction data.
{
"reconciliation_rule_variables":[
{
"direction": "credit",
"amount_lower_bound": 10000,
"amount_upper_bound": 11000,
"internal_account_id": "<Internal Account ID>",
"date_lower_bound": "2024-05-15",
"date_upper_bound": "2024-05-22",
"custom_identifiers":{
"buyer_email_address": "[email protected]",
"payment_id": "abc123"
}
}
]
}