Payment Resource

The Payments resource is a core resource of the Convera API Suite and defines an outgoing payment to be released to a beneficiary for receipt of funds. All payments that are submitted to Convera are subject to regulatory and sanctions scanning prior to release.

The Payments resource contains several required fields, along with optional fields depending on the type of payment being submitted. The Payment Validator Resource can be used to help determine which fields should be submitted for a given currency, payment method, and beneficiary location.

Once through initial payment body validation and accepted into a Created state, payments cannot be updated through a PUT request.

The input parameter payment id is created and assigned by the Partner using a unique value. This value should be unique at the customer-level, meaning different customers under the same Partner ID can use the same payment id. Once an id has been used at the customer-level, a new one should be generated to prevent ID collision.

A single PUT request is limited to either 10,000 payments, or 2Mb in size (whichever comes first without violating the 10,000 payments per batch limit).

As payments progress through workflow, status changes are automatically communicated through webhooks if configured, or through a manual Get Payment request.

📘

Same-Day ACH

For Same Day ACH (SDA) payments, if the payment has been committed after cut-off time, the SDA payment will be released the next day.

Payments must meet the following criteria:

  • Payments to US only (international SDA is not supported)
  • Customer must be based in US
  • Supported for USD only
  • Amount must be less than $100,000 USD
{
    "id": string,
    "customerId": string,
    "status": string,
    "errorCode": string,
    "partnerReference": string,
    "createdOn": string,
    "lastUpdatedOn": string,
    "paymentMethod": string,
    "paymentReference": string,
    "paymentVersion": string,
    "amount": 0,
    "currencyCode": string,
    "settlementAmount": 0,
    "settlementCurrencyCode": string,
    "isFixedAmountInSettlementCurrency": true,
    "chargeType": string,
    "valueDate": string,
    "amountReturned": 0,
    "amountReturnedCurrency": string,
    "updateErrorCode": string,
    "updateErrorOn": string,
    "purposeOfPayment": string,
    "instructionForBank": string,
    "instructionCodeForBank": string,
    "remittanceType": string,
    "remittanceData": [
        {
            "ref": string
        },
    ],
    "beneficiary": {
        "id": string,
        "versionedOn": string,
        "email": string,
        "type": string,
        "taxId": string,
        "firstName": string,
        "middleName": string,
        "lastName": string,
        "phoneNumber": string,
        "cellNumber": string,
        "dateOfBirth": string,
        "gender": string,
        "occupation": string,
        "identificationDocumentType": string,
        "identificationDocumentNumber": string,
        "identificationDocumentCountry": string,
        "employerName": string,
        "alias": string,
        "authorizedUsers": {
            "user1": string,
            "user2": string,
            "user3": string
        },
        "businessName": string,
        "businessRegistrationNumber": string,
        "businessRegistrationCountry": string,
        "businessRegistrationStateProv": string,
        "industry": string,
        "address": {
            "line1": string,
            "line2": string,
            "line3": string,
            "city": string,
            "stateOrProv": string,
            "zipOrPostal": string,
            "countryCode": string
        }
    },
    "bankAccount": {
        "id": string,
        "versionedOn": string,
        "accountNumber": string,
        "accountType": string,
        "bankName": string,
        "bankBranchName": string,
        "bankCode": string,
        "bankBranchCode": string,
        "address": {
            "line1": string,
            "line2": string,
            "line3": string,
            "city": string,
            "stateOrProv": string,
            "zipOrPostal": string,
            "countryCode": string
        },
        "intermediaryBank": {
            "bankName": string,
            "bankCode": string,
            "accountNumber": string,
            "bankBranchCode": string,
            "address": {
                "line1": string,
                "line2": string,
                "line3": string,
                "city": string,
                "stateOrProv": string,
                "zipOrPostal": string,
                "countryCode": string
            }
        }
    },
    "thirdPartyRemitter": {
        "id": string,
        "versionedOn": string,
        "type": string,
        "businessName": string,
        "address": {
            "line1": string,
            "line2": string,
            "line3": string,
            "city": string,
            "stateOrProv": string,
            "zipOrPostal": string,
            "countryCode": string
        },
        "email": string,
        "phoneNumber": string,
        "identificationType": string,
        "identification": string,
        "industry": string,
        "bankAccount": {
            "accountNumber": string,
            "accountCurrency": string,
            "bankCode": string,
            "bankRoutingCode": string
        },
    },
    "originatingFI": {
        "id": string,
        "versionedOn": string,
        "accountNumber": string,
        "accountType": string,
        "bankName": string,
        "bankCode": string,
        "address": {
            "line1": string,
            "line2": string,
            "line3": string,
            "city": string,
            "stateOrProv": string,
            "zipOrPostal": string,
            "countryCode": string
        }
    }
}
{
    "payments": [
        {
            //General payment information
            "customerID": "Customer123",
            "partnerReference": "",
            "paymentMethod": "Wire",
            "id": "Payment123",
            "amount": 50099,
            "currencyCode": "EUR",
            "settlementCurrencyCode": "USD",
            "valueDate": "2023-01-01",
            "isFixedAmountInSettlementCurrency": "false",
            "purposeOfPayment": "Sample purpose of payment",
            "instructionForBank": "",
            "instructionCodeForBank": "",
            "remittanceType": "CTX",
            "remittanceData": [
                {
                    "ref": ""
                }
            ],
            "isDoddFrank": "false",
          
            //Beneficiary Information
            "beneficiary": {
                "id": "Bene_Id_123",
                "versionedOn": "2022-03-09T13:04:34Z",
                "email": "",
                "type": "individual",
                "taxID": "",
                "firstName": "John",
                "middleName": "",
                "lastName": "Smith",
                "phoneNumber": "",
                "cellNumber": "",
                "dateOfBirth": "",
                "gender": "",
                "occupation": "",
                "identificationDocumentType": "",
                "identificationDocumentNumber": "",
                "identificationDocumentCountry": "",
                "employerName": "",
                "alias": "",
                "authorizedUsers": {
                    "user1": "",
                    "user2": "",
                    "user3": ""
                },
                "businessName": "",
                "businessRegistrationNumber": "",
                "businessRegistrationCountry": "",
                "businessRegistrationStateProv": "",
                "industry": "",
                "address": {
                    "line1": "340 Warehouse Lane",
                    "line2": "",
                    "line3": "",
                    "city": "New York",
                    "stateOrProv": "NY",
                    "zipOrPostal": "10005",
                    "countryCode": "US"
                }
            },
          
            //Beneficiary Bank Information
            "bankAccount": {
                "id": "Bank_Id_123",
                "versionedOn": "2020-03-09T13:04:34Z",
                "accountNumber": "123456789",
                "accountType": "checking",
                "bankName": "Bank of New York",
                "bankBranchName": "",
                "bankCode": "IRVTUS3NXXX",
                "bankBranchCode": "",
                "address": {
                    "line1": "123 Apple Street",
                    "line2": "",
                    "line3": "",
                    "city": "New York",
                    "stateOrProv": "NY",
                    "zipOrPostal": "10005",
                    "countryCode": "US"
                },
                "intermediaryBank": {
                    "bankName": "",
                    "bankCode": "",
                    "accountNumber": "",
                    "address": {
                        "line1": "",
                        "line2": "",
                        "line3": "",
                        "city": "",
                        "stateOrProv": "",
                        "zipOrPostal": "",
                        "countryCode": ""
                    }
                }
            },
          
            //Third-Party Remitter Information
            "thirdPartyRemitter": {
                "id": "Third_Party_Id_123",
                "versionedOn": "2022-03-09T13:04:34Z",
                "type": "partnership",
                "businessName": "Remitting, Inc.",
                "address": {
                    "line1": "560 Remitting Avenue",
                    "line2": "",
                    "line3": "",
                    "city": "New York",
                    "stateOrProv": "NY",
                    "zipOrPostal": "10005",
                    "countryCode": "US"
                },
                "email": "",
                "phoneNumber": "",
                "identificationType": "",
                "identification": "",
                "industry": "",
                "bankAccount": {
                    "accountNumber": "1234567890",
                    "accountCurrency": "USD",
                    "bankCode": "BCDDXX02",
                    "bankRoutingCode": "BRCXXXWU02"
                }
            },
          
            //Originating FI Information
            "originatingFI": {
                "id": "OFI_Id_123",
                "versionedOn": "2022-03-09T13:04:34Z",
                "accountNumber": "1234567890",
                "accountType": "checking",
                "bankName": "Bank of New York",
                "bankCode": "IRVTUS3NXXX",
                "accountCurrency": "USD",
                "bankRoutingCode": "",
                "address": {
                    "line1": "123 Originating Drive",
                    "line2": "",
                    "line3": "",
                    "city": "Atlanta",
                    "stateOrProv": "GA",
                    "zipOrPostal": "30336",
                    "countryCode": "US"
                }
            }
        }
    ]
}