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. More information about the Payments resource can be found in the Guide section under Payments Resource.

{
    "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,
    "uetr": string,
    "amountReturned": 0,
    "amountReturnedCurrency": string,
    "updateErrorCode": string,
    "updateErrorOn": string,
    "purposeOfPayment": string,
    "purposeOfPaymentCode": 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",
            "uetr": "",
            "isFixedAmountInSettlementCurrency": "false",
            "purposeOfPayment": "Sample purpose of payment",
            "purposeOfPaymentCode": "Sample code",
            "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"
                }
            }
        }
    ]
}