Payments

The full list of request body parameters and possible outcomes can be found here.

Most operations support the option to pass an idempotencyKey.

Request a payment or payout

Send a payment or payout.

RequestCardSource source = RequestCardSource.builder().build(); // other sources are also supportedRequestIndividualSender sender = RequestIndividualSender.builder().build(); // other sender types are also supportedPaymentRequest request = Payments.card(source).individualSender(sender).build();
//or PaymentRequest request = Payments.card(source).individualSender(sender).build();
PaymentResponse response = api.paymentsClient().requestPayment(request).get();

RequestCurrencyAccountSource source = RequestCurrencyAccountSource.builder().build(); // other sources are also supportedRequestCorporateSender sender = RequestCorporateSender.builder().build(); // other sender types are also supportedPayoutRequest request = Payouts.account(source).corporateSender(sender).build();
PayoutResponse response = api.paymentsClient().requestPayout(request).get();

Get payment details

Returns the details of the payment with the specified identifier string.

PaymentResponse response = api.paymentsClient().getPayment(id).get();

Get payment actions

Returns all the actions associated with a payment ordered by processing date in descending order (latest first).

List<PaymentAction> response = api.paymentsClient().getPaymentActions(paymentId).get();

Capture a payment

Captures a payment if supported by the payment method.

CaptureRequest captureRequest = CaptureRequest.builder()    .reference()    .metadata()    .build();
CaptureResponse response = api.paymentsClient().capturePayment(paymentId, captureRequest).get();

Refund a payment

Refunds a payment if supported by the payment method.

RefundRequest refundRequest = RefundRequest.builder()    .reference(UUID.randomUUID().toString())    .build();
RefundResponse response = api.paymentsClient().refundPayment(paymentId, refundRequest).get();

Void a payment

Voids a payment if supported by the payment method.

VoidRequest voidRequest = VoidRequest.builder()    .reference(UUID.randomUUID().toString())    .build();
VoidResponse response = api.paymentsClient().voidPayment(paymentId, voidRequest).get();