Our full API documentation can be found here for OTMS. It describes our endpoints and the way we accept data.
URL http://transportial.com
Transportial info@transportial.com
Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.
curl -i -X PUT \ https://docs.transportial.com/_mock/apis/payout \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "administration": { "nonce": "string", "name": "string", "primary": true, "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "banners": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": {}, "amount": {} } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceStandardDocuments": [ { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } ], "quoteStandardDocuments": [ { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } ], "invoiceNumbering": 0, "quoteNumbering": 0 }, "amount": { "nonce": "string", "amount": 0.1, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "source": { "nonce": "string", "amount": 0, "type": "ach_credit_transfer", "clientSecret": "string", "codeVerification": "string", "achCreditTransfer": { "nonce": "string", "account_number": "string", "bank_name": "string", "fingerprint": "string", "refund_account_holder_name": "string", "refund_account_holder_type": "string", "refund_routing_number": "string", "routing_number": "string", "swift_code": "string" }, "achDebit": { "nonce": "string", "bank_name": "string", "country": "string", "fingerprint": "string", "last4": "string", "routing_number": "string", "type": "string" }, "acssDebit": { "nonce": "string", "bank_address_city": "string", "bank_address_line_1": "string", "bank_address_line_2": "string", "bank_address_postal_code": "string", "bank_name": "string", "category": "string", "country": "string", "fingerprint": "string", "last4": "string", "routing_number": "string" }, "alipay": { "nonce": "string", "data_string": "string", "native_url": "string", "statement_descriptor": "string" }, "auBecsDebit": { "nonce": "string", "bsb_number": "string", "fingerprint": "string", "last4": "string" }, "bancontact": { "nonce": "string", "bank_code": "string", "bank_name": "string", "bic": "string", "iban_last4": "string", "preferred_language": "string", "statement_descriptor": "string" }, "card": { "nonce": "string", "address_line1_check": "string", "address_zip_check": "string", "brand": "string", "country": "string", "cvc_check": "string", "description": "string", "dynamic_last4": "string", "exp_month": 0, "exp_year": 0, "fingerprint": "string", "funding": "string", "iin": "string", "issuer": "string", "last4": "string", "name": "string", "three_d_secure": "string", "tokenization_method": "string" }, "cardPresent": { "nonce": "string", "application_cryptogram": "string", "application_preferred_name": "string", "authorization_code": "string", "authorization_response_code": "string", "brand": "string", "country": "string", "cvm_type": "string", "data_type": "string", "dedicated_file_name": "string", "description": "string", "emv_auth_data": "string", "evidence_customer_signature": "string", "evidence_transaction_certificate": "string", "exp_month": 0, "exp_year": 0, "fingerprint": "string", "funding": "string", "iin": "string", "issuer": "string", "last4": "string", "pos_device_id": "string", "pos_entry_mode": "string", "read_method": "string", "reader": "string", "terminal_verification_results": "string", "transaction_status_information": "string" }, "eps": { "nonce": "string", "reference": "string", "statement_descriptor": "string" }, "ideal": { "nonce": "string", "bank": "string", "bic": "string", "iban_last4": "string", "statement_descriptor": "string" }, "klarna": { "nonce": "string", "background_image_url": "string", "client_token": "string", "first_name": "string", "last_name": "string", "locale": "string", "logo_url": "string", "page_title": "string", "pay_later_asset_urls_descriptive": "string", "pay_later_asset_urls_standard": "string", "pay_later_name": "string", "pay_later_redirect_url": "string", "pay_now_asset_urls_descriptive": "string", "pay_now_asset_urls_standard": "string", "pay_now_name": "string", "pay_now_redirect_url": "string", "pay_over_time_asset_urls_descriptive": "string", "pay_over_time_asset_urls_standard": "string", "pay_over_time_name": "string", "pay_over_time_redirect_url": "string", "payment_method_categories": "string", "purchase_country": "string", "purchase_type": "string", "redirect_url": "string", "shipping_first_name": "string", "shipping_last_name": "string" }, "multibanco": { "nonce": "string", "entity": "string", "reference": "string", "refund_account_holder_address_city": "string", "refund_account_holder_address_country": "string", "refund_account_holder_address_line1": "string", "refund_account_holder_address_line2": "string", "refund_account_holder_address_postal_code": "string", "refund_account_holder_address_state": "string", "refund_account_holder_name": "string", "refund_iban": "string" }, "p24": { "nonce": "string", "reference": "string" }, "sepaCreditTransfer": { "nonce": "string", "bank_name": "string", "bic": "string", "iban": "string", "refund_account_holder_address_city": "string", "refund_account_holder_address_country": "string", "refund_account_holder_address_line1": "string", "refund_account_holder_address_line2": "string", "refund_account_holder_address_postal_code": "string", "refund_account_holder_address_state": "string", "refund_account_holder_name": "string", "refund_iban": "string" }, "sepaDebit": { "nonce": "string", "bank_code": "string", "branch_code": "string", "country": "string", "fingerprint": "string", "last4": "string", "mandate_reference": "string", "mandate_url": "string" }, "sofort": { "nonce": "string", "bank_code": "string", "bank_name": "string", "bic": "string", "country": "string", "iban_last4": "string", "preferred_language": "string", "statement_descriptor": "string" }, "threeDSecure": { "nonce": "string", "address_line1_check": "string", "address_zip_check": "string", "authenticated": true, "brand": "string", "card": "string", "country": "string", "customer": "string", "cvc_check": "string", "description": "string", "dynamic_last4": "string", "exp_month": 0, "exp_year": 0, "fingerprint": "string", "funding": "string", "iin": "string", "issuer": "string", "last4": "string", "name": "string", "three_d_secure": "string", "tokenization_method": "string" }, "wechat": { "nonce": "string", "prepay_id": "string", "qr_code_url": "string", "statement_descriptor": "string" } }, "failed": true, "bankAccount": { "nonce": "string", "routingNumber": "string", "accountNumber": "string", "last4": "string", "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "country": "string", "validation": { "nonce": "string", "firstValue": 0.1, "secondValue": 0.1 }, "validated": true, "accountHolderName": "string", "accountHolderType": "string", "bankName": "string" }, "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ] }'
{ "success": true, "message": "string", "code": 0, "payout": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "amount": { … }, "source": { … }, "failed": true, "bankAccount": { … }, "identifiers": [ … ] }, "transaction": { "id": "string", "nonce": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "name": "string", "description": "string", "status": "SUCCESS", "transferredFrom": "string", "transferredTo": "string", "creator": { … }, "fromUser": { … }, "fromBusiness": { … }, "toUser": { … }, "toBusiness": { … }, "amount": { … }, "fee": { … }, "net": { … }, "parent": {}, "source": { … }, "type": "INTERNAL" } }
curl -i -X POST \ https://docs.transportial.com/_mock/apis/payout \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "nonce": "string", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" }, "banners": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": {}, "amount": {} } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string", "path": "string", "name": "string", "originalName": "string", "size": 0, "purpose": "string", "type": "IMAGE", "mimeType": "string", "extension": "string", "uploadedAt": "2019-08-24T14:15:22Z" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": {}, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "amount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "source": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0, "type": "ach_credit_transfer", "clientSecret": "string", "codeVerification": "string", "achCreditTransfer": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "accountNumber": "string", "bankName": "string", "fingerprint": "string", "refundAccountHolderName": "string", "refundAccountHolderType": "string", "refundRoutingNumber": "string", "routingNumber": "string", "swiftCode": "string" }, "achDebit": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bankName": "string", "country": "string", "fingerprint": "string", "last4": "string", "routingNumber": "string", "type": "string" }, "acssDebit": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bankAddressCity": "string", "bankAddressLine1": "string", "bankAddressLine2": "string", "bankAddressPostalCode": "string", "bankName": "string", "category": "string", "country": "string", "fingerprint": "string", "last4": "string", "routingNumber": "string" }, "alipay": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "dataString": "string", "nativeUrl": "string", "statementDescriptor": "string" }, "auBecsDebit": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bsbNumber": "string", "fingerprint": "string", "last4": "string" }, "bancontact": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bankCode": "string", "bankName": "string", "bic": "string", "ibanLast4": "string", "preferredLanguage": "string", "statementDescriptor": "string" }, "card": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "addressLine1Check": "string", "addressZipCheck": "string", "brand": "string", "country": "string", "cvcCheck": "string", "description": "string", "dynamicLast4": "string", "expMonth": 0, "expYear": 0, "fingerprint": "string", "funding": "string", "iin": "string", "issuer": "string", "last4": "string", "name": "string", "threeDSecure": "string", "tokenizationMethod": "string" }, "cardPresent": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "applicationCryptogram": "string", "applicationPreferredName": "string", "authorizationCode": "string", "authorizationResponseCode": "string", "brand": "string", "country": "string", "cvmType": "string", "dataType": "string", "dedicatedFileName": "string", "description": "string", "emvAuthData": "string", "evidenceCustomerSignature": "string", "evidenceTransactionCertificate": "string", "expMonth": 0, "expYear": 0, "fingerprint": "string", "funding": "string", "iin": "string", "issuer": "string", "last4": "string", "posDeviceId": "string", "posEntryMode": "string", "readMethod": "string", "reader": "string", "terminalVerificationResults": "string", "transactionStatusInformation": "string" }, "eps": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "reference": "string", "statementDescriptor": "string" }, "ideal": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bank": "string", "bic": "string", "ibanLast4": "string", "statementDescriptor": "string" }, "klarna": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "backgroundImageUrl": "string", "clientToken": "string", "firstName": "string", "lastName": "string", "locale": "string", "logoUrl": "string", "pageTitle": "string", "payLaterAssetUrlsDescriptive": "string", "payLaterAssetUrlsStandard": "string", "payLaterName": "string", "payLaterRedirectUrl": "string", "payNowAssetUrlsDescriptive": "string", "payNowAssetUrlsStandard": "string", "payNowName": "string", "payNowRedirectUrl": "string", "payOverTimeAssetUrlsDescriptive": "string", "payOverTimeAssetUrlsStandard": "string", "payOverTimeName": "string", "payOverTimeRedirectUrl": "string", "paymentMethodCategories": "string", "purchaseCountry": "string", "purchaseType": "string", "redirectUrl": "string", "shippingFirstName": "string", "shippingLastName": "string" }, "multibanco": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "entity": "string", "reference": "string", "refundAccountHolderAddressCity": "string", "refundAccountHolderAddressCountry": "string", "refundAccountHolderAddressLine1": "string", "refundAccountHolderAddressLine2": "string", "refundAccountHolderAddressPostalCode": "string", "refundAccountHolderAddressState": "string", "refundAccountHolderName": "string", "refundIban": "string" }, "p24": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "reference": "string" }, "sepaCreditTransfer": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bankName": "string", "bic": "string", "iban": "string", "refundAccountHolderAddressCity": "string", "refundAccountHolderAddressCountry": "string", "refundAccountHolderAddressLine1": "string", "refundAccountHolderAddressLine2": "string", "refundAccountHolderAddressPostalCode": "string", "refundAccountHolderAddressState": "string", "refundAccountHolderName": "string", "refundIban": "string" }, "sepaDebit": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bankCode": "string", "branchCode": "string", "country": "string", "fingerprint": "string", "last4": "string", "mandateReference": "string", "mandateUrl": "string" }, "sofort": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "bankCode": "string", "bankName": "string", "bic": "string", "country": "string", "ibanLast4": "string", "preferredLanguage": "string", "statementDescriptor": "string" }, "threeDSecure": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "addressLine1Check": "string", "addressZipCheck": "string", "authenticated": true, "brand": "string", "card": "string", "country": "string", "customer": "string", "cvcCheck": "string", "description": "string", "dynamicLast4": "string", "expMonth": 0, "expYear": 0, "fingerprint": "string", "funding": "string", "iin": "string", "issuer": "string", "last4": "string", "name": "string", "threeDSecure": "string", "tokenizationMethod": "string" }, "wechat": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "prepayId": "string", "qrCodeUrl": "string", "statementDescriptor": "string" } }, "failed": true, "bankAccount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "accountHolderName": "string", "accountHolderType": "string", "bankName": "string", "routingNumber": "string", "accountNumber": "string", "last4": "string", "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "country": "string", "validation": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstValue": 0.1, "secondValue": 0.1 }, "validated": true }, "identifiers": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ] }'
{ "success": true, "message": "string", "code": 0, "payout": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "amount": { … }, "source": { … }, "failed": true, "bankAccount": { … }, "identifiers": [ … ] }, "transaction": { "id": "string", "nonce": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "name": "string", "description": "string", "status": "SUCCESS", "transferredFrom": "string", "transferredTo": "string", "creator": { … }, "fromUser": { … }, "fromBusiness": { … }, "toUser": { … }, "toBusiness": { … }, "amount": { … }, "fee": { … }, "net": { … }, "parent": {}, "source": { … }, "type": "INTERNAL" } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/payout/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "payout": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "amount": { … }, "source": { … }, "failed": true, "bankAccount": { … }, "identifiers": [ … ] }, "transaction": { "id": "string", "nonce": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "name": "string", "description": "string", "status": "SUCCESS", "transferredFrom": "string", "transferredTo": "string", "creator": { … }, "fromUser": { … }, "fromBusiness": { … }, "toUser": { … }, "toBusiness": { … }, "amount": { … }, "fee": { … }, "net": { … }, "parent": {}, "source": { … }, "type": "INTERNAL" } }
curl -i -X DELETE \ 'https://docs.transportial.com/_mock/apis/payout/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "payout": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "amount": { … }, "source": { … }, "failed": true, "bankAccount": { … }, "identifiers": [ … ] }, "transaction": { "id": "string", "nonce": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "name": "string", "description": "string", "status": "SUCCESS", "transferredFrom": "string", "transferredTo": "string", "creator": { … }, "fromUser": { … }, "fromBusiness": { … }, "toUser": { … }, "toBusiness": { … }, "amount": { … }, "fee": { … }, "net": { … }, "parent": {}, "source": { … }, "type": "INTERNAL" } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/payouts/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "payouts": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/payouts/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "payout": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "amount": { … }, "source": { … }, "failed": true, "bankAccount": { … }, "identifiers": [ … ] }, "transaction": { "id": "string", "nonce": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "administration": { … }, "name": "string", "description": "string", "status": "SUCCESS", "transferredFrom": "string", "transferredTo": "string", "creator": { … }, "fromUser": { … }, "fromBusiness": { … }, "toUser": { … }, "toBusiness": { … }, "amount": { … }, "fee": { … }, "net": { … }, "parent": {}, "source": { … }, "type": "INTERNAL" } }
Events - like actions - model dynamic entities that couple various static entities at a certain moment in time. Events are used for either real-time updates, or updates on earlier provided data. Notice that in both event types these are updates on earlier provided data, whereas actions are usually used together with the entities they dynamically couple.
Goods are the items to be transported as part of a consignment. Goods can be divided into two sub-types of goods, depending on the use case and the level of detail. Goods either consists of items, describing the actual goods to be transported. Or a transport equipment, which is equipment used to carry the actual goods to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.
TransportEquipment are the items to be transported as part of a consignment. TransportEquipment can be divided into two sub-types of transportEquipment, depending on the use case and the level of detail. TransportEquipment either consists of items, describing the actual transportEquipment to be transported. Or a transport equipment, which is equipment used to carry the actual transportEquipment to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.