Before you can create a transfer you must create a wallet.

After using the createTransfer mutation the next step is to use finalizeTransfer to initiate the transfer.

If wire attribute is not provided on the mutation, it will default to false. This will prioritize a local payment over a wire.

Parameters

Parameter	Type	Required
user_id	UUID!	true
entity_id	UUID!	true
source_amount	String	false
wallet_id	UUID	false
destination_amount	String	false
account_id	UUID	false
beneficiary_id	UUID!	true
purpose_of_payment	String!	true
reference	String	false
wire	Boolean	false
document_reference	String	false

Graphql

mutation createTransfer (
    $user_id: UUID!
    $entity_id: UUID!
    $source_amount: String
    $wallet_id: UUID
    $destination_amount: String
    $beneficiary_id: UUID!
    $purpose_of_payment: String!
    $reference: String
) {
    createTransfer (
        user_id: $user_id
        entity_id: $entity_id
        source_amount: $source_amount
        wallet_id: $wallet_id
        destination_amount: $destination_amount
        beneficiary_id: $beneficiary_id
        purpose_of_payment: $purpose_of_payment
        reference: $reference
    )
}