B2B Payments API reference

API reference for business-to-business payments: create payment contracts that send a payment or request one, manage their invoices and recipients, and transfer funds between wallets.

Contracts

• Create a payment contract: POST /payment-contracts
• Run a B2B payment contract end to end: B2B contract flow. Header PayMe-Merchant-Key = MPL. payment.type 1 send (initiator pays) or 2 request (recipient pays); the recipient approves in PayMe. Methods: funds-transfer, credit-card, il-direct-debit (ILS only, 320); card/debit max 5000000 (393). Card: tokenize, add-card-to-seller, send buyer_key top level. A repeat create within 5 min returns the same contract. Status 1, 2, 3 (auto), 4; or 5 with error_code 11000-11004 (read error_code); payment-contract-* callbacks. Change: PUT /payment-contracts/{guid}; cancel: .../cancellations (initiator); files: .../invoices. Errors 380-394.
• List payment contracts: GET /payment-contracts
• List contract files: GET /payment-contracts/{payment_contract_guid}/invoices
• Upload contract files: POST /payment-contracts/{payment_contract_guid}/invoices
• Replace a contract file: PUT /payment-contracts/{payment_contract_guid}/invoices/{invoice_guid}
• Delete a contract file: DELETE /payment-contracts/{payment_contract_guid}/invoices/{invoice_guid}
• List previous recipients: GET /payment-contracts/recipients

Wallets

• Transfer funds between sellers: POST /sales